home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / programs / msgtrm10.zip / MSGTRIM.DOC < prev    next >
Text File  |  1993-03-07  |  16KB  |  309 lines
  1.                         ┌─────────────────────────┐
  2.                         │    Message Trim 1.0     │
  3.                         └─────────────────────────┘
  4.  
  5.  
  6.                              !!!! WARNING !!!!
  7.   !!   This Program Is Designed for GT 16.00 and Higher Specifically   !!
  8.   !!   Use on any other version could prove hazardous to your system   !!
  9.  
  10.        ──────────────────────────────────────────────────────────────
  11.                                   History
  12.        ──────────────────────────────────────────────────────────────
  13.  
  14.          01-26-92   Ver 1.0 Initial Release
  15.  
  16.        ──────────────────────────────────────────────────────────────
  17.                               A Request!
  18.        ──────────────────────────────────────────────────────────────
  19.  
  20.          Allot of time and effort has went into the birth, growth, and
  21.          testing of this program.  I just want to encourage all echo
  22.          sponsors and/or echo bridgers to take a close look at this
  23.          program and consider using it PRIOR to bagging echo areas you
  24.          are sponsoring and/or bridging.  In the not so distant past
  25.          GT Echo Conferences were very nice to read and use.  Lately
  26.          however with the new sudden popularity and usage of QWK and
  27.          bridging in the GT Network, many many echos are becoming
  28.          overridden with Tag Lines, Reader Signatures, Auto Generated
  29.          Quoting, and Bridging information that the average user does
  30.          not care to have crowding a message they want to read.  All
  31.          to many messages have more of this text in them than human
  32.          generated text.  Message Trim provides a generously
  33.          configurable and easily implemented method of discarding much
  34.          of this unwanted information.  If you are a system that is
  35.          sponsoring or bridging an echo conference for the GT Network,
  36.          PLEASE consider "Trimming" your message areas prior to your
  37.          bagging runs on a daily basis.  It will make cleaner messages
  38.          and an overall better network for all of us.  I am giving
  39.          this program to the network free of charge and expect no
  40.          gratuities, please consider using it to its fullest.
  41.  
  42.  
  43.        ──────────────────────────────────────────────────────────────
  44.                                 What is It?
  45.        ──────────────────────────────────────────────────────────────
  46.          Message Trim is a utility that searches the text of your
  47.          message areas in search of items you have configured in you
  48.          "Search List". If any of these items are found they are
  49.          "Trimmed" from the text of the message.  The primary idea
  50.          behind a "search item" are those annoying little tag lines,
  51.          quote lines, and reader signatures. Your configuration can
  52.          hold up to 1000 individual "search items".
  53.  
  54.        ──────────────────────────────────────────────────────────────
  55.                                   Why Is It?
  56.        ──────────────────────────────────────────────────────────────
  57.  
  58.          You may be asking about now, Why would you want to do this?
  59.          Well there are two primary reasons for doing this.  First of
  60.          all you can possibly save valuable disk space by removing
  61.          unwanted text from your message areas.  The primary reason
  62.          you would want to do this is to remove all the unnecessary
  63.          and annoying auto generated text that has made it's way into
  64.          your message areas via QWK readers, offline readers, and echo
  65.          bridging software.  So the basic idea is this, if you want to
  66.          save some disk space, or you are tired of reading all the
  67.          auto generated text, or you just want you message areas to
  68.          have a look of cleanliness that GT echos used to have, then
  69.          MSGTRIM is for you!
  70.  
  71.        ──────────────────────────────────────────────────────────────
  72.                               Configuration...
  73.        ──────────────────────────────────────────────────────────────
  74.  
  75.          The Message Trim configuration consists of two parts.  The
  76.          first part consists of three parameters that tell Message
  77.          Trim how to deal with Blank lines and .ORIGIN lines.  The
  78.          second part of the configuration consists of editing the
  79.          actual "Search Items" that Message Trim will be searching
  80.          for.  First lets talk about the Blank and .ORIGIN line
  81.          parameters.  When you first enter config you will be
  82.          presented with the following menu.
  83.  
  84.     ╔═══════════════════════════════════════════════════════════════════╗
  85.     ║                                                                   ║██
  86.     ║                                                                   ║██
  87.     ║       Maximum Blank Lines To Allow At Top Of Message.....[000]    ║██
  88.     ║       Maximum Sequential Blank Lines To Allow............[002]    ║██
  89.     ║       Maximum Total Origin Lines To Allow................[002]    ║██
  90.     ║                                                                   ║██
  91.     ║                                                                   ║██
  92.     ║            F1 Help  F2 Active Keys  F3 Edit Remove List           ║██
  93.     ║                                                                   ║██
  94.     ╚═══════════════════════════════════════════════════════════════════╝██
  95.              ██████████████████████████████████████████████████████████████
  96.  
  97.  
  98.         The first item "Maximum Blank Lines To Allow At Top Of
  99.         Message" allows you to specify the Maximum number of blanks to
  100.         leave prior to the first line in the message that contains a
  101.         character other than a space.  Specifying 0 on this line will
  102.         cause MSGTRIM to strip ALL blank lines from the top of the
  103.         message.
  104.  
  105.         The second item "Maximum Sequential Blank Lines To Allow"
  106.         allows you to specify the Maximum number of blank lines to
  107.         allow sequentially in your messages.  If you specify 2 for
  108.         this field MSGTRIM will strip all blank lines that follow any
  109.         2 sequential blanks in a message.  Please Note that if this
  110.         number is less than the number you specified for Blank Lines
  111.         At Top Of Message, you will override the "Blank At Top"
  112.         parameter.
  113.  
  114.         The third item "Maximum Total Origin Lines To Allow" allows
  115.         you to specify the Maximum number of lines the .ORIGIN line
  116.         will be allowed to consume.  .ORIGIN lines are stored in
  117.         messages as one long continuous line and are wrapped at 80
  118.         columns by GT and various readers.  If you allow the .ORIGIN
  119.         line to occupy 2 lines in a message, .ORIGIN lines in excess
  120.         of 160 characters will be truncated.  If any .ORIGIN lines are
  121.         truncated, and they contain any from of ANSI Escape sequences,
  122.         an ANSI reset ESC[0m will be appended to the end of the
  123.         .ORIGIN line.
  124.  
  125.  
  126.  
  127.  
  128.         After you have set these three parameters you are ready to
  129.         start editing the actual "Search Items" in the configuration.
  130.         To get to the "Search Item" editing menu press F3.  You will
  131.         then be presented with the following menu.
  132.  
  133.  
  134.  ┌───────────────────────────────────────────────────────────────────────┐
  135.  │Line Applied By Blue Wave Reader                                       │██
  136.  └───────────────────────────────────────────────────────────────────────┘██
  137.            █████████████████████████████████████████████████████████████████
  138.  
  139.  ╔═════════════[ESC Exit  F1 Help  F2 Key Help  F3 ASCII Chart]══════════╗
  140.  ║    Blue Wave                                                          ║
  141.  ║    GoldED                                                             ║██
  142.  ║   SLMR                                                                ║██
  143.  ║  *SLMR                                                                ║██
  144.  ║ # Origin                                                              ║██
  145.  ║ # SLMR                                                                ║██
  146.  ║ * 1st                                                                 ║██
  147.  ║ * ATP/LINUX                                                           ║██
  148.  ║ * DeLuxe                                                              ║██
  149.  ║ * DeepSouthNet                                                        ║██
  150.  ║ * Deluxe                                                              ║██
  151.  ║ * FQ                                                                  ║██
  152.  ║ * GT                                                                  ║██
  153.  ║ * Jabber                                                              ║██
  154.  ║ * KWQ/2                                                               ║██
  155.  ╚═════════════════════════[ Item 1 of 102 Total ]═══════════════════════╝██
  156.            █████████████████████████████████████████████████████████████████
  157.  
  158.  
  159.         At the top of you screen you will notice a box that contains a
  160.         comment for the current line you are on.  You can now edit the
  161.         current line, edit the comment for this entry, duplicate the
  162.         entry, insert blank line, or delete the entry.  Press F2 to
  163.         see a list of keys that provide these functions.  You will
  164.         find MSGTRIM comes configured with over 100 entries in the
  165.         configuration.  These items consist of common Tag Lines,
  166.         Signature Lines, and Quote Indicators. You are free to add to
  167.         or delete from this list as you see fit for your
  168.         implementation.  You are allotted 1000 entries in the
  169.         configuration.
  170.  
  171.        ──────────────────────────────────────────────────────────────
  172.                                  Execution..
  173.        ──────────────────────────────────────────────────────────────
  174.  
  175.          After configuration, running the program is fairly easy.  If
  176.          you have a GTPATH environment variable set, and a GTMDIR.BBS
  177.          file in the directory pointed to by <GTPATH> then all you
  178.          have to do is type MSGTRIM on the DOS command line.  MSGTRIM
  179.          will then proceed to read the GTMDIR.BBS file and process
  180.          each message area listed and remove any text found that
  181.          matches any of the "Search Item" entries on a line by line
  182.          basis.  If you wish to search only a portion of you available
  183.          message areas you can create an alternate GTMDIR.BBS file.
  184.          See "Command Line Parameters" below in this document for the
  185.          method of specifying an alternate GTMDIR.BBS file.
  186.  
  187.  
  188.        ──────────────────────────────────────────────────────────────
  189.                           Command Line Parameters
  190.        ──────────────────────────────────────────────────────────────
  191.  
  192.          There's six possibilities.
  193.  
  194.  
  195.              /CONFIG
  196.  
  197.          Enter MSGTRIM config mode.
  198.  
  199.  
  200.              /GTM:<ALT_GTMDIR>
  201.  
  202.          Don't use the GTMDIR.BBS file in the GTPATH directory.
  203.          Substitute a full path and filename for <ALT_GTMDIR>.  This
  204.          allows you to specify an alternate filename so you don't have
  205.          to process all your message areas if you choose not to.
  206.  
  207.  
  208.             /L
  209.  
  210.          If you want MSGTRIM to keep an ongoing log file of the text
  211.          removed from your messages use this parameter.  Your log file
  212.          will be <GTPATH>\HOTWARE\MSGTRIM.LOG.  If you use this
  213.          parameter the next execution will append to the existing log
  214.          file.  You must manually delete this log file to avoid
  215.          filling up your disk.
  216.  
  217.  
  218.              /NL
  219.  
  220.          If you want MSGTRIM to keep a log file, but not to append to
  221.          the existing log file use this parameter.  The difference
  222.          between this parameter and /L is that if a log file exists it
  223.          will be truncated to 0 length prior to writing to it.  This
  224.          prevents you log file from growing to an excessive length.
  225.  
  226.  
  227.              /REGISTER
  228.  
  229.          If you would like to use the Auto Registration feature of
  230.          MSGTRIM, use this parameter.  MSGTRIM will send a
  231.          registration message to ROB ROESCH at 064/003 via netmail
  232.          when this parameter is used.
  233.  
  234.             /?
  235.  
  236.          This parameter will show you all the available command line
  237.          parameters with a brief description of each.
  238.  
  239.  
  240.        ──────────────────────────────────────────────────────────────
  241.                            Active Keyboard Input
  242.        ──────────────────────────────────────────────────────────────
  243.  
  244.          MSGTRIM has the ability to exit various levels of execution
  245.          at your request.  There are two different "breaks" out of the
  246.          program.  Listed on the execution screen you will notice that
  247.          the ESCAPE and F1 keys will allow you to break out of the
  248.          various MSGTIM Loops.  F1 will break out of the current
  249.          message area and continue with the next message area.  ESCAPE
  250.          will do a graceful and immediate exit from the program.
  251.  
  252.        ──────────────────────────────────────────────────────────────
  253.                                  Errorlevels
  254.        ──────────────────────────────────────────────────────────────
  255.  
  256.          Here are the possible errorlevel exits the program will give.
  257.       
  258.                   ERRORLEVEL 0  No Problems, Good Run.....
  259.                   ERRORLEVEL 1  Cannot Open Configuration File
  260.                   ERRORLEVEL 2  Cannot Open GTMDIR.BBS
  261.                   ERRORLEVEL 3  Early Exit Requested
  262.                   ERRORLEVEL 4  GTPATH Environment Variable Not Set
  263.                   ERRORLEVEL 5  Invalid command line parameter
  264.                   ERRORLEVEL 6  Insufficient Memory For Allocation
  265.  
  266.  
  267.        ──────────────────────────────────────────────────────────────
  268.                                 Registration
  269.        ──────────────────────────────────────────────────────────────
  270.  
  271.         I am not requesting any money for this program, but I would
  272.         not turn any down either <g>.  If you want to slip $5.00 into
  273.         and envelope I'll accept it.  Although I don't require a
  274.         registration fee I would appreciate knowing that you are using
  275.         the program on a normal basis.  Therefore I have provided a
  276.         simple and easy way for you to register this program.  From
  277.         the DOS prompt type:
  278.  
  279.  
  280.          MSGTRIM /REGISTER
  281.  
  282.       MSGTRIM will the proceed to send me a netmail message informing
  283.       me that you are using the program.  Please use this feature
  284.       ONCE.
  285.  
  286.  
  287.        ──────────────────────────────────────────────────────────────
  288.                             Who Is Responsible for This?
  289.        ──────────────────────────────────────────────────────────────
  290.                                  Rob Roesch
  291.                               The HOTware BBS
  292.                          GT Power Net-Node 064/003
  293.                                 Rt 7 Box 566
  294.                                Mocksville, NC
  295.                          704-492-2081 (USR 16.8 DS)
  296.  
  297.           If you start using this utility, and get a chance, let me
  298.           know (see above procedures.  If you don't have any use for
  299.           it, delete it for your total refund of all the disk space
  300.           that it was occupying.  This program comes with no warranty,
  301.           no guarantee, and no promises.  If it works GREAT, if not
  302.           let me know and I will gladly take a look at it in my spare
  303.           time.  If you really really really like the program and want
  304.           to make any donations, feel free, but it is not a
  305.           requirement.....
  306.  
  307.  
  308.  
  309.